API Documentation
BufferCast.h
1 // BufferCast.h
3 //
5 
6 namespace nkMemory
7 {
16  template <typename T = unsigned char>
17  class BufferCast
18  {
19  public :
20 
21  // Constructors, destructor
25  BufferCast () = default ;
32  BufferCast (unsigned long long size) ;
39  BufferCast (T* data, unsigned long long size) ;
46  BufferCast (const Buffer& buffer) ;
53  BufferCast (Buffer&& buffer) ;
60  BufferCast (const BufferCast& cast) ;
72  ~BufferCast () = default ;
73 
74  public :
75 
76  // Getters
80  T* getData () const ;
84  unsigned long long getSize () const ;
88  bool empty () const ;
92  T& front () ;
96  T& back () ;
97 
98  public :
99 
100  // Management
104  void clear () ;
111  void resize (unsigned long long size) ;
119  T& append (const T& value) ;
136 
137  public :
138 
139  // Operators
146  T& operator[] (unsigned long long index) ;
153  const T& operator[] (unsigned long long index) const ;
154 
155  public :
156 
157  // Templated constructors
163  BufferCast (const std::vector<T>& vec) ;
164  } ;
165 }
nkMemory::BufferCast::getSize
unsigned long long getSize() const
nkMemory::BufferCast::BufferCast
BufferCast()=default
nkMemory::BufferCast::append
T & append(const T &value)
nkMemory::BufferCast::BufferCast
BufferCast(T *data, unsigned long long size)
nkMemory::BufferCast::back
T & back()
nkMemory::BufferCast::getData
T * getData() const
nkMemory::BufferCast::empty
bool empty() const
nkMemory::Buffer
A buffer holding binary data.
Definition: Buffer.h:32
nkMemory::BufferCast::BufferCast
BufferCast(const std::vector< T > &vec)
nkMemory::BufferCast::operator[]
T & operator[](unsigned long long index)
nkMemory::BufferCast::front
T & front()
nkMemory::BufferDataDescriptor
Describes the data held by a buffer.
Definition: Buffer.h:12
nkMemory::BufferCast::relinquishBufferOwnership
Buffer relinquishBufferOwnership()
nkMemory::BufferCast
Holds a Buffer and make it easy to cast the binary data.
Definition: BufferCast.h:18
nkMemory::BufferCast::resize
void resize(unsigned long long size)
nkMemory::BufferCast::BufferCast
BufferCast(Buffer &&buffer)
nkMemory::BufferCast::~BufferCast
~BufferCast()=default
nkMemory::BufferCast::relinquishDataOwnership
BufferDataDescriptor relinquishDataOwnership()
nkMemory::BufferCast::BufferCast
BufferCast(unsigned long long size)
nkMemory::BufferCast::clear
void clear()
nkMemory::BufferCast::BufferCast
BufferCast(const Buffer &buffer)
nkMemory::BufferCast::BufferCast
BufferCast(const BufferCast &cast)
nkMemory
Encompasses all API of component NilkinsMemory.
Definition: Allocator.h:7
nkMemory::BufferCast::BufferCast
BufferCast(BufferCast &&cast)